/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable.events;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.Comparator;

import cgl.narada.event.EventID;
/** This class encapsulates the notification issued by the reliable service
    after it has archived an event.

    Among other things, the event contains information pertaining to
    (a) The event id of the archived event
    (b) The sequence number of the archived event
    (c) The sequence number of previously archived events
    (d) The template id

    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public class RdArchivalServiceNotification implements Comparator {
  /** The template id of the archived event */
  private int templateId;
  
  /** The assigned sequencing information */
  private long sequenceNumber;

  /** The last assigned sequencing information for this template */
  private long previousSequenceNumber;

  /** The event identifier */
  private EventID eventId;

  private String moduleName = "RdArchivalServiceNotification: ";

  
  public RdArchivalServiceNotification(int templateId, EventID eventId,
				       long sequenceNumber, 
				       long previousSequenceNumber) {
    this.templateId = templateId;
    this.eventId = eventId;
    this.sequenceNumber = sequenceNumber;
    this.previousSequenceNumber = previousSequenceNumber;
  }
  

  

  /** Retrieves the templateId of the archived event */
  public int getTemplateId() {
    return templateId;
  }

  /** Retriev the event identifier of the archived event */
  public EventID getEventId() {
    return eventId;
  }

  /** Retrieves the sequence number for this event */
  public long getSequenceNumber() {
    return sequenceNumber;

  }

   /** Retrieves the previous sequence number for this event */
  public long getPreviousSequenceNumber() {
    return previousSequenceNumber;
  }


  public String toString() {
    String stringRep = "ArchivalNotification -> template=" + templateId + 
      "sequenceNum = " + sequenceNumber + "previousSeqNum=" +
      previousSequenceNumber;

    return stringRep;

  }


  /** For this implementation it is assumed that the entity id and
      template id of the compared object is the same */
  public boolean equals(Object obj) {
    RdArchivalServiceNotification compareWith = 
      (RdArchivalServiceNotification) obj;
    
    if (sequenceNumber == compareWith.getSequenceNumber())
      return true;
    
    return false;
    
  }
  
  /** For this implementation it is assumed that the entity id and
      template id of the compared objects are the same. We only deal with
      the catenation numbers here. This plays a role in the SortedSet being
      maintain in the RdsEventPercolator*/
  public int compare(Object one, Object two) {
    RdArchivalServiceNotification comOne = (RdArchivalServiceNotification) one;
    RdArchivalServiceNotification comTwo = (RdArchivalServiceNotification) two;
    
    return (int)(comOne.getSequenceNumber() - comTwo.getSequenceNumber());
  }




  /** Reconstruction of the event from the serialized byte stream 
      representation */
  public RdArchivalServiceNotification(byte[] marshalledBytes) {
    ByteArrayInputStream baInputStream = 
      new ByteArrayInputStream(marshalledBytes);
    DataInputStream din = new DataInputStream(baInputStream);
    
    try {
      din.readByte(); /**ReliableDeliveryExchange.ARCHIVAL_NOTIFICATION */
      
      templateId = din.readInt();
      
      byte[] eventIdBytes = new byte[din.readInt()];
      din.readFully(eventIdBytes);
      eventId = new EventID(eventIdBytes);
      
      sequenceNumber = din.readLong();
      previousSequenceNumber = din.readLong();
      

    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while un-marshalling");
    }

 }





  /** Create a serialized representation of the byte stream */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);
    byte[] marshalledBytes= null;
    try {
      dout.writeByte(ReliableDeliveryExchange.ARCHIVAL_NOTIFICATION);
      
      dout.writeInt(templateId);

      byte[] eventIdBytes = eventId.getBytes();
      dout.writeInt(eventIdBytes.length);
      dout.write(eventIdBytes);

      dout.writeLong(sequenceNumber);
      dout.writeLong(previousSequenceNumber);

      dout.flush();
      marshalledBytes = baOutputStream.toByteArray();
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while marshalling");
    } /** end try-catch block*/
    
    return marshalledBytes;


  }

}
